Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adds filter by tags and contentType to library home [FC-0059] #1141

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Jul 2, 2024

Description

This PR adds filters (tag and block type) to the content library home. It also includes a refactor to create a search-manager feature with hooks and components that can be reused while querying the meilisearch index.
image
image

More Info:


Private ref: FAL-3763 and FAL-3764

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 2, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Jul 2, 2024

Thanks for the pull request, @rpenido!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link

codecov bot commented Jul 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.68%. Comparing base (77135cd) to head (317c3e7).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1141   +/-   ##
=======================================
  Coverage   92.68%   92.68%           
=======================================
  Files         693      693           
  Lines       12342    12342           
  Branches     2661     2694   +33     
=======================================
  Hits        11439    11439           
  Misses        872      872           
  Partials       31       31           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rpenido rpenido force-pushed the rpenido/fal-3764-library-home-filter-by-content-type branch 3 times, most recently from 07b3a03 to dfd3190 Compare July 3, 2024 11:34
@rpenido rpenido changed the title feat: library home filter by content type feat: adds filter by tags and contentType to library home [FC-0059] Jul 3, 2024
@rpenido rpenido force-pushed the rpenido/fal-3764-library-home-filter-by-content-type branch 2 times, most recently from 2672082 to c453ef0 Compare July 5, 2024 16:15
@bradenmacdonald
Copy link
Contributor

@rpenido This PR should be unblocked now

Copy link
Contributor Author

@rpenido rpenido Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing this file with .ts extension didn't work.
I was getting the following error:

export 'CreateLibrary' (imported as 'CreateLibrary') was not found in './library-authoring' (module has no exports)

Renaming to .tsx or js fixed the issue. I don't know why. I'm not sure if the problem is in my stack.

@rpenido rpenido force-pushed the rpenido/fal-3764-library-home-filter-by-content-type branch from f591fbe to 3d66e47 Compare July 23, 2024 17:33
@rpenido rpenido marked this pull request as ready for review July 23, 2024 17:34
@rpenido rpenido requested a review from a team as a code owner July 23, 2024 17:34
@rpenido
Copy link
Contributor Author

rpenido commented Jul 23, 2024

Hi @bradenmacdonald !
This is ready for CC review.

@rpenido rpenido force-pushed the rpenido/fal-3764-library-home-filter-by-content-type branch from 3d66e47 to 317c3e7 Compare July 23, 2024 17:42
Refactor to add search-manager feature.

Co-authored-by:  Yusuf Musleh <[email protected]>
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice work, @rpenido - thanks!

I tested this on the library home page and the course search modal.

@bradenmacdonald bradenmacdonald merged commit 25ab1ff into openedx:master Jul 24, 2024
7 checks passed
@openedx-webhooks
Copy link

@rpenido 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@bradenmacdonald
Copy link
Contributor

@rpenido Was there a reason you squashed this PR by the way? I think that makes it a lot harder for @pomegranited to rebase her PR now, because the recent commits you've added are kind of lost in the squash.

@rpenido
Copy link
Contributor Author

rpenido commented Jul 24, 2024

Hi @bradenmacdonald!
It was my bad. I thought they would get lost anyway because of the squash at the merge, right?

I have the following backup branch before the squash.

https://github.com/open-craft/frontend-app-course-authoring/tree/rpenido/bkp/fal-3764-before-squash-before-conflicts

I created a PR handling the conflicts here, but it still needs some work (I may have accidentally removed something):

I'm really sorry @pomegranited 😞

@bradenmacdonald
Copy link
Contributor

Thanks @rpenido ! It's not a big deal, but having the unsquashed branch makes it easier to merge in, especially because you had already done the work of updating your branch with the latest master.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jul 30, 2024
@rpenido rpenido deleted the rpenido/fal-3764-library-home-filter-by-content-type branch August 13, 2024 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Library Home - Filter by Content Type
4 participants